Skip to content

Conversation

@isaackps
Copy link
Collaborator

@isaackps isaackps commented Sep 23, 2025

Rename "OpenAttestationEmbeddedRenderer" to "EmbeddedRenderer".

As there is an update to OA.


Preview | Diff

index.html Outdated

<section>
<h4>OpenAttestationEmbeddedRenderer</h4>
<h4>DecentralizedRenderer</h4>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A naming question here. What about the renderer itself makes it decentralized?

From the description, it sounds like this is a renderer that uses HTML in an embedded or nested browsing context, in particular, it suggests an iframe must be used. If the latter is true (and intended to be true carrying forward), perhaps IFrameRenderer would be an appropriate name to describe why/how this renderer is different from the other renderer types.

If there's some other layer to the abstraction here and use of an iframe is an implementation detail, perhaps it suggests the name ought to be ExternalRenderer or EmbeddedRenderer -- where there is some External/Embedded "ACTION" API to communicate with it?

If the main feature of this type of renderer is that it has this "ACTION" API communication capability, perhaps the name should be based on that, e.g., ActionableRenderer or ActionDrivenRenderer (or similar). Perhaps those names are slightly awkard or insufficiently specific -- but I wouldn't suggest InteractiveRenderer since "interactivity" could be a property of many different renderer types.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the thoughtful feedback!

After some discussion within the team, we agree that the name should stay close to how the renderer actually works. Based on your suggestions, we think EmbeddedRenderer would be the most accurate and intuitive choice, since it reflects that the rendering happens in an embedded context.

We’ll proceed with updating the naming accordingly.

@isaackps isaackps changed the title fix: update OpenAttestationEmbeddedRenderer to DecentralizedRenderer fix: update OpenAttestationEmbeddedRenderer to EmbeddedRenderer Oct 8, 2025
@isaackps
Copy link
Collaborator Author

isaackps commented Oct 8, 2025

Hi @dlongley,

Thanks for the feedback, have updated it to be EmbeddedRenderer instead.

Copy link
Member

@msporny msporny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to figure out the context issue in this PR.

  • The PR should be updated to refer to the new issue on the topic.
  • The images need descriptions for screen readers (for people that have low/no-vision sight needs). I have used LLMs to generate these descriptions and they do a pretty good job (sometimes) if you give them enough context on what the image is showing.

Copy link
Collaborator

@dmitrizagidulin dmitrizagidulin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@dmitrizagidulin
Copy link
Collaborator

Issue #33 (to deal with the @context and vocab issue) opened on the Weds renderMethod call. This PR can be merged meanwhile.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants